juce/source/extras/the jucer/src/model/components/jucer_TreeViewHandler.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #ifndef __JUCER_TREEVIEWHANDLER_JUCEHEADER__
  27 #define __JUCER_TREEVIEWHANDLER_JUCEHEADER__
  28
  29
  30 //==============================================================================
  31 /**
  32 */
  33 class TreeViewHandler  : public ComponentTypeHandler
  34 {
  35 public:
  36     //==============================================================================
  37     TreeViewHandler()
  38         : ComponentTypeHandler ("TreeView", "TreeView", typeid (DemoTreeView), 150, 150)
  39     {
  40         registerColour (TreeView::backgroundColourId, "background", "backgroundColour");
  41         registerColour (TreeView::linesColourId, "lines", "linecol");
  42     }
  43
  44     //==============================================================================
  45     Component* createNewComponent (JucerDocument*)
  46     {
  47         return new DemoTreeView();
  48     }
  49
  50     XmlElement* createXmlFor (Component* comp, const ComponentLayout* layout)
  51     {
  52         TreeView* const t = dynamic_cast <TreeView*> (comp);
  53         XmlElement* const e = ComponentTypeHandler::createXmlFor (comp, layout);
  54
  55         e->setAttribute ("rootVisible", t->isRootItemVisible());
  56         e->setAttribute ("openByDefault", t->areItemsOpenByDefault());
  57
  58         return e;
  59     }
  60
  61     bool restoreFromXml (const XmlElement& xml, Component* comp, const ComponentLayout* layout)
  62     {
  63         if (! ComponentTypeHandler::restoreFromXml (xml, comp, layout))
  64             return false;
  65
  66         TreeView defaultTreeView;
  67         TreeView* const t = dynamic_cast <TreeView*> (comp);
  68
  69         t->setRootItemVisible (xml.getBoolAttribute ("rootVisible", defaultTreeView.isRootItemVisible()));
  70         t->setDefaultOpenness (xml.getBoolAttribute ("openByDefault", defaultTreeView.areItemsOpenByDefault()));
  71
  72         return true;
  73     }
  74
  75     void getEditableProperties (Component* component, JucerDocument& document, Array <PropertyComponent*>& properties)
  76     {
  77         ComponentTypeHandler::getEditableProperties (component, document, properties);
  78         TreeView* const t = dynamic_cast <TreeView*> (component);
  79
  80         properties.add (new TreeViewRootItemProperty (t, document));
  81         properties.add (new TreeViewRootOpennessProperty (t, document));
  82
  83         addColourProperties (t, document, properties);
  84     }
  85
  86     const String getCreationParameters (Component* comp)
  87     {
  88         return quotedString (comp->getName());
  89     }
  90
  91     void fillInCreationCode (GeneratedCode& code, Component* component, const String& memberVariableName)
  92     {
  93         TreeView defaultTreeView;
  94         TreeView* const t = dynamic_cast <TreeView*> (component);
  95
  96         ComponentTypeHandler::fillInCreationCode (code, component, memberVariableName);
  97
  98         if (defaultTreeView.isRootItemVisible() != t->isRootItemVisible())
  99         {
 100             code.constructorCode
 101                 << memberVariableName << "->setRootItemVisible ("
 102                 << boolToString (t->isRootItemVisible()) << ");\n";
 103         }
 104
 105         if (defaultTreeView.areItemsOpenByDefault() != t->areItemsOpenByDefault())
 106         {
 107             code.constructorCode
 108                 << memberVariableName << "->setDefaultOpenness ("
 109                 << boolToString (t->areItemsOpenByDefault()) << ");\n";
 110         }
 111
 112         code.constructorCode << getColourIntialisationCode (component, memberVariableName);
 113
 114         code.constructorCode << "\n";
 115     }
 116
 117 private:
 118     //==============================================================================
 119     class DemoTreeView : public TreeView
 120     {
 121     public:
 122         DemoTreeView()
 123             : TreeView ("new treeview")
 124         {
 125             setRootItem (new DemoTreeViewItem ("Demo root node", 4));
 126         }
 127
 128         ~DemoTreeView()
 129         {
 130             TreeViewItem* root = getRootItem();
 131             setRootItem (0);
 132             delete root;
 133         }
 134
 135     private:
 136         class DemoTreeViewItem  : public TreeViewItem
 137         {
 138         public:
 139             DemoTreeViewItem (const String& name_, const int numItems)
 140                 : name (name_)
 141             {
 142                 for (int i = 0; i < numItems; ++i)
 143                     addSubItem (new DemoTreeViewItem ("Demo sub-node " + String (i), numItems - 1));
 144             }
 145
 146             ~DemoTreeViewItem()
 147             {
 148             }
 149
 150             void paintItem (Graphics& g, int width, int height)
 151             {
 152                 if (isSelected())
 153                     g.fillAll (Colours::lightblue);
 154
 155                 g.setColour (Colours::black);
 156                 g.setFont (height * 0.7f);
 157                 g.drawText (name, 4, 0, width - 4, height, Justification::centredLeft, true);
 158             }
 159
 160             bool mightContainSubItems()
 161             {
 162                 return true;
 163             }
 164
 165             const String name;
 166         };
 167     };
 168
 169     //==============================================================================
 170     class TreeViewRootItemProperty  : public ComponentBooleanProperty <TreeView>
 171     {
 172     public:
 173         TreeViewRootItemProperty (TreeView* comp, JucerDocument& document)
 174             : ComponentBooleanProperty <TreeView> ("show root item", "Root item visible", "Root item visible", comp, document)
 175         {
 176         }
 177
 178         void setState (bool newState)
 179         {
 180             document.perform (new TreeviewRootChangeAction (component, *document.getComponentLayout(), newState),
 181                               "Change TreeView root item");
 182         }
 183
 184         bool getState() const
 185         {
 186             return component->isRootItemVisible();
 187         }
 188
 189     private:
 190         class TreeviewRootChangeAction  : public ComponentUndoableAction <TreeView>
 191         {
 192         public:
 193             TreeviewRootChangeAction (TreeView* const comp, ComponentLayout& layout, const bool newState_)
 194                 : ComponentUndoableAction <TreeView> (comp, layout),
 195                   newState (newState_)
 196             {
 197                 oldState = comp->isRootItemVisible();
 198             }
 199
 200             bool perform()
 201             {
 202                 showCorrectTab();
 203                 getComponent()->setRootItemVisible (newState);
 204                 changed();
 205                 return true;
 206             }
 207
 208             bool undo()
 209             {
 210                 showCorrectTab();
 211                 getComponent()->setRootItemVisible (oldState);
 212                 changed();
 213                 return true;
 214             }
 215
 216             bool newState, oldState;
 217         };
 218     };
 219
 220     //==============================================================================
 221     class TreeViewRootOpennessProperty  : public ComponentChoiceProperty <TreeView>
 222     {
 223     public:
 224         TreeViewRootOpennessProperty (TreeView* comp, JucerDocument& document)
 225             : ComponentChoiceProperty <TreeView> ("default openness", comp, document)
 226         {
 227             choices.add ("Items open by default");
 228             choices.add ("Items closed by default");
 229         }
 230
 231         void setIndex (int newIndex)
 232         {
 233             document.perform (new TreeviewOpennessChangeAction (component, *document.getComponentLayout(), newIndex == 0),
 234                               "Change TreeView openness");
 235         }
 236
 237         int getIndex() const
 238         {
 239             return component->areItemsOpenByDefault() ? 0 : 1;
 240         }
 241
 242     private:
 243         class TreeviewOpennessChangeAction  : public ComponentUndoableAction <TreeView>
 244         {
 245         public:
 246             TreeviewOpennessChangeAction (TreeView* const comp, ComponentLayout& layout, const bool newState_)
 247                 : ComponentUndoableAction <TreeView> (comp, layout),
 248                   newState (newState_)
 249             {
 250                 oldState = comp->areItemsOpenByDefault();
 251             }
 252
 253             bool perform()
 254             {
 255                 showCorrectTab();
 256                 getComponent()->setDefaultOpenness (newState);
 257                 changed();
 258                 return true;
 259             }
 260
 261             bool undo()
 262             {
 263                 showCorrectTab();
 264                 getComponent()->setDefaultOpenness (oldState);
 265                 changed();
 266                 return true;
 267             }
 268
 269             bool newState, oldState;
 270         };
 271     };
 272 };
 273
 274
 275 #endif   // __JUCER_TREEVIEWHANDLER_JUCEHEADER__